home *** CD-ROM | disk | FTP | other *** search
/ Gamers Delight 2 / Gamers Delight 2.iso / Aminet / game / hint / DungeonMap.lha / DungeonMap / DungeonMap.doc < prev    next >
Text File  |  1992-12-06  |  12KB  |  274 lines
  1.                         DungeonMap V1.1
  2.                         ===============
  3.  
  4. A Programmer's Plea
  5. -------------------
  6.  
  7.   DungeonMap is shareware.  If you find this program useful, please send $ to:
  8.  
  9.       Bill Elliot
  10.       727 94 Ave SW.,
  11.       Calgary, Alberta
  12.       T2V 0X8
  13.  
  14.   Some suggested amounts are as follows:
  15.  
  16.        $5 - You like the software
  17.       $10 - You like the software, and would like a copy of the next upgrade.
  18.       $25 - You like the software, and would like a copy of the next upgrade
  19.             and a copy of the source.
  20.  
  21.       If outside Canada and the US, and are choosing the $10 or $25 option,
  22.       please add an extra $4 for the extra international postage & handling.
  23.  
  24.   Even if you think that DungeonMap is terrible, I would appreciate a letter 
  25.   giving me CONSTRUCTIVE ideas on how I can improve it.
  26.  
  27.   Please promote the shareware system by making a contribution to the authors
  28.   of the shareware products you commonly use.  There are many advantages to
  29.   the shareware system:
  30.  
  31.       -- You can receive quality programs at a decent price.  Had this been
  32.          a commercial program, you could expect to pay at least $19.95.
  33.  
  34.       -- You can thoroughly examine a shareware program before reimbursing
  35.          the author.  Once you've purchased a commercial program, however,
  36.          you're stuck with it.
  37.  
  38.       -- You promote the creation of a number of exciting and diverse
  39.          programs that would otherwise not reach the public if commercial
  40.          marketing was the only alternative.
  41.  
  42.   Along with your $, please send your name, address, and the version number
  43.   of DungeonMap that you are currently using.  This can be found by displaying
  44.   the Information requester located in the Program menu.
  45.  
  46.  
  47. Disclaimer
  48. ----------
  49.  
  50.   DungeonMap is provided "AS IS" without warranty of any kind, either expressed
  51.   or implied.  By using DungeonMap, you agree to accept the entire risk as to
  52.   the quality and performance of the program.  Bill Elliot will not accept any
  53.   liability for this product.
  54.  
  55.  
  56. Legal Bits...
  57. ---------------------------------
  58.  
  59.   Now, for the legal stuff.  You don't need to read this unless you plan on
  60.   uploading, distributing, marketing, or stealing DungeonMap...
  61.  
  62.   DungeonMap is © Copyright 1992 by Bill Elliot
  63.     All Rights are Reserved Worldwide
  64.  
  65.   DungeonMap is freely distributable as long as all of the following 
  66.   conditions are met:
  67.  
  68.       1) All of the files must be included in their original form without
  69.          additions, deletions, or modifications of any kind.  Any such
  70.          modifications must appear in separate files.
  71.  
  72.       2) All copyright notices must remain intact.
  73.  
  74.       3) DungeonMap may not be sold commercially alone or as a component in
  75.          another product.
  76.  
  77.       4) DungeonMap may not appear on shareware or public domain disks for
  78.          which the consumers are charged more than a nominal disk copying fee
  79.          of seven dollars (US $7) per disk.
  80.  
  81.       5) DungeonMap may not appear on any electronic service which charges 
  82.          more than the basic access fee to download DungeonMap.
  83.  
  84.       6) DungeonMap may not appear on any electronic service that claims
  85.          copyrights to uploaded programs, either alone or as part of a
  86.          collection.
  87.  
  88.   If you would like a variance to any of the above conditions, please contact
  89.   me for written permission.
  90.  
  91.   Now, on to DungeonMap (IE. What your really reading this for)...
  92.  
  93.  
  94. Software Requirements
  95. ---------------------
  96.  
  97.   This software was written and tested on AmigaDos versions 1.3 and 2.0. So
  98.   it should run on most machines. It has not been tested with ENFORCER, as I
  99.   don't have an MMU (If any one does test it with ENFORCER and finds a 
  100.   problem, please drop me a note and tell me).
  101.  
  102.   DungeonMap uses the REQ.LIBRARY. Since I hate getting shareware software
  103.   that requires some special library and does not include it, I have included
  104.   the library and a routine to install the library for those that don't have
  105.   REQ.LIBRARY. Future releases may not need this library, as I intend to
  106.   convert over to use the new ASL.LIBRARY of AmigaDos 2.0.
  107.  
  108. Using DungeonMap
  109. ----------------
  110.  
  111.   DungeonMap is intended to be used as an aid to Dungeon Masters (DM's) © TSR
  112.   for creating dungeons for use in Advanced Dungeons & Dragons (AD&D) © TSR.
  113.   But, you can use it for what ever you like.
  114.  
  115.   The legend says "Door" and "Arch". But, these can be interpreted any way you
  116.   please (Eg. Door's could be locked or secret doors, and Arch's could be open
  117.   or unlocked doors). Just use your imagination. For the most part the program
  118.   is self explanitory.  I'll just cover some of the more subtle points/features.
  119.  
  120.   Loading Saved Maps...
  121.   
  122.     DungeonMap will first look for a directory (in what ever directory you
  123.     ran DungeonMap from) called DungeonMapData.  If DungeonMapData is found 
  124.     DungeonMap will display the files in this directory. Otherwise, it will
  125.     display the files in the current directory. NOTE: All files saved by
  126.     DungeonMap are forced to have a suffix of ".DAT". Therefore, only files
  127.     ending in ".DAT" are  displayed.  This helps save some time scrolling 
  128.     through other unrelated files.
  129.  
  130.     As the dungeon data is loaded, messages are displayed in the drag bar
  131.     after every 100 nodes are loaded.  This gives you some idea of what is 
  132.     happening during those long loads (Eg. a 1400 node map).
  133.  
  134.   Saving Maps...
  135.  
  136.     The same proceedure as above is used for selecting which directory to
  137.     display files from.  But, this selection process is only for the first
  138.     save or load.  The requester will keep the directory you may change it
  139.     to (at least till you quite the program).
  140.  
  141.   Choosing a Map format...
  142.  
  143.     This allows you to chose the style of map to generate. You can chose a
  144.     dungeon style that is irregular in shape. Or, you can create a town, which
  145.     is rectangular, and where you can control the straightness of the roads
  146.     (among other things).
  147.  
  148.   Creating new Dungeons...
  149.  
  150.     This is really what your here for.  You will be presented with a 
  151.     requester which asks how for the size of dungeon to create and how you
  152.     want it created. (IE. What proportion of the exits will be OPEN, WALLS,
  153.     DOORS, and ARCHS).  Just a warning on size.  I would not try anything 
  154.     larger than say 2000 nodes.  Even this will take a fairly long time.
  155.  
  156.     If you get tired of waiting for the dungeon to be completed, or you feel
  157.     enough dungeon has been created, then the process can be stopped.  Just
  158.     select the "NEW MAP" option again.  You will notice that while creating
  159.     a map the "NEW MAP" option will read "STOP MAP".
  160.  
  161.     Here are a couple of the messages you wll see displayed in the drag bar,
  162.     while the Map is being created. They, and their meanings are as follows:
  163.  
  164.       "Creating dungeon of xxx nodes. yyy nodes created."
  165.  
  166.       This is just a progress report saying that xxx nodes of the requested
  167.       yyy nodes have been created. You will also see the dungeon being drawn as
  168.       it is created.
  169.  
  170.       "No undefined exits. Choosing a new start point for dungeon generation..."
  171.  
  172.       If there are no more undefined exits, a new one is created, at random,
  173.       on one of the outside edges. Then the dungeon creation will continue from
  174.       there.
  175.  
  176.   Editing the Dungeon...
  177.  
  178.     Just click the mouse close to a wall, door, arch, or opening to change it
  179.     to the item selected under menu item "Change to". The selection process
  180.     looks at each node like it had a diagonal cross through it, and selects
  181.     the exit from the node that it is in. This is easier to visualize with a
  182.     picture. So....
  183.     
  184.                   Exit
  185.                +--------+
  186.                |\      /|
  187.                | \    / | <------- Entire square is a node on the map.
  188.                |  \  /  |
  189.          Exit  |   \/   |  Exit
  190.                |   /\   |
  191.                |  /  \  |
  192.                | /    \ |
  193.                |/      \|
  194.                +--------+
  195.                   Exit
  196.  
  197.     If you try to create an exit on an undefined node, the node will be made
  198.     defined (IE, turned grey).  If this was an accident and you want the node
  199.     to be undefined (IE. white), then just select "Change to - Undefined" and
  200.     click the mouse anywhere on the node.
  201.  
  202.     A future zoom option will make this easier to edit.
  203.  
  204.   Creating new Towns...
  205.  
  206.     The requester will ask for the width and height of the maze. These values
  207.     must be an odd number. The maximums are calculated based on the amount of
  208.     overscan you are using.
  209.  
  210.     Then there are 3 controls for steets. The straightness must be between 1
  211.     and 99%. Te straighter the streets must be the slower the town creation
  212.     will be. The other 2 street controls (Start at wall, & Start at courts)
  213.     control where the streets begin, and how many there are. The limits on
  214.     these values vary depending on the size of the town (the larger the town
  215.     the more streets there can be). If you ask for too many the program will
  216.     let you know.
  217.  
  218.     The final 2 controls control the number of Gates into the town there will
  219.     be (upper limit is less than or equal to the number of streets starting at
  220.     the wall), and the number of unused cells in the town (eg. pillar, rock,
  221.     etc). Again these are limited based on the size of the town.
  222.  
  223.     The generation of a town can be stoped in the same way as with the dungeon
  224.     map creation (select STOP MAP). But, this option is only checked between
  225.     major steps of the town creation (IE. it may not be as quick to respond).
  226.     In a future release I'll probably make this more responsive. But, it wll
  227.     probably slow down the creation of the town.
  228.  
  229.     I would very much like to thank Kent Paul Dolan for presenting his
  230.     algorithm for creating a town map in his program TownMaze.
  231.  
  232.   Editing the Town...
  233.  
  234.     Editing towns is easier than dungeons. The cells contain only one object
  235.     (a wall, open space, or door). There is no need to select a specific 
  236.     portion of a cell. The entire cell is changed to the selected type.
  237.  
  238.   Choosing the size of the print...
  239.  
  240.     There are 2 sizes or formats for printing the maps. The first I call
  241.     "Fixed Size Cell", has all maps regardless of size having each cell
  242.     printed the same size. The second format is called "Max Cell Size". This
  243.     prints the map as large as will fit on the paper (paper size is controled
  244.     via Preferences).
  245.  
  246.   Printing the map...
  247.   
  248.     While the dungeon map is being printed, you sometimes want to cancel the
  249.     printout.  This could be because you chose the option by accident or
  250.     because it is taking too long (due to the print density chosen).  Well,
  251.     this is no problem.  While a dungeon is printing the print option will
  252.     read "STOP PRINT".  Just select this option again and the print will be
  253.     stopped.  This should happen immediately.  The only output that should 
  254.     still be printed is just what is already in the printers internal buffer.
  255.  
  256.     The maps (dungeons & towns) are all printed in the background. So, while
  257.     it is being printed, you can continue with loading, or creating new maps.
  258.  
  259.     The printing controls for DungeonMap are all controlled via your 
  260.     preferences (set through Workbench). Note: that B/W gives a much better
  261.     print out over grey scale, and that density 2 is usually good enough.
  262.  
  263.   Displaying the legend...
  264.  
  265.     The legend is an option, that when selected, will display a small window.
  266.     This legend window can be moved to anywhere on the screen, so you can
  267.     keep it out of your way. It will not be printed if it is displayed.
  268.  
  269.   Exiting from DungeonMap...
  270.   
  271.     If you are printing, creating a new map, or haven't saved your most
  272.     recent creation/change, them you will be told this, and asked what you
  273.     wish to do about it.  I believe in graceful exits.
  274.